<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Reload search analyzers API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'indices-reload-analyzers.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/indices-reload-analyzers.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/indices-reload-analyzers.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/indices-reload-analyzers.html" rel="nofollow" target="_blank">../en/indices-reload-analyzers.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-node">Reload search analyzers API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="migration-api-deprecation.html">« Deprecation info APIs</a>
</span>
<span class="next">
<a href="rollup-apis.html">Rollup APIs »</a>
</span>
</div>
<div class="chapter xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="indices-reload-analyzers"></a>Reload search analyzers API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/indices/apis/reload-analyzers.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Reloads an index’s <a class="xref" href="search-analyzer.html" title="search_analyzer">search analyzers</a> and their resources.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST /twitter/_reload_search_analyzers</pre>
</div>
<div class="console_widget" data-snippet="snippets/1865.console"></div>
<h3>
<a id="indices-reload-analyzers-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/indices/apis/reload-analyzers.asciidoc">edit</a>
</h3>
<p><code class="literal">POST /&lt;index&gt;/_reload_search_analyzers</code></p>
<p><code class="literal">GET /&lt;index&gt;/_reload_search_analyzers</code></p>
<h3>
<a id="indices-reload-analyzers-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/indices/apis/reload-analyzers.asciidoc">edit</a>
</h3>
<p>You can use the reload search analyzers API
to pick up changes to synonym files
used in the <a class="xref" href="analysis-synonym-graph-tokenfilter.html" title="Synonym graph token filter"><code class="literal">synonym_graph</code></a>
or <a class="xref" href="analysis-synonym-tokenfilter.html" title="Synonym token filter"><code class="literal">synonym</code></a> token filter
of a <a class="xref" href="search-analyzer.html" title="search_analyzer">search analyzer</a>.
To be eligible,
the token filter must have an <code class="literal">updateable</code> flag of <code class="literal">true</code>
and only be used in search analyzers.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>This API does not perform a reload
for each shard of an index.
Instead,
it performs a reload for each node
containing index shards.
As a result,
the total shard count returned by the API
can differ from the number of index shards.</p>
<p>Because reloading affects every node with an index shard,
its important to update the synonym file
on every data node in the cluster,
including nodes that don’t contain a shard replica,
before using this API.
This ensures the synonym file is updated
everywhere in the cluster
in case shards are relocated
in the future.</p>
</div>
</div>
<h3>
<a id="indices-reload-analyzers-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/indices/apis/reload-analyzers.asciidoc">edit</a>
</h3>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;index&gt;</code>
</span>
</dt>
<dd>
(Required, string)
Comma-separated list or wildcard expression of index names
used to limit the request.
</dd>
</dl>
</div>
<h3>
<a id="indices-reload-analyzers-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/indices/apis/reload-analyzers.asciidoc">edit</a>
</h3>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">allow_no_indices</code>
</span>
</dt>
<dd>
<p>
(Optional, boolean) If <code class="literal">true</code>,
the request does <span class="strong strong"><strong>not</strong></span> return an error
if a wildcard expression
or <code class="literal">_all</code> value retrieves only missing or closed indices.
</p>
<p>This parameter also applies to <a class="xref" href="indices-aliases.html" title="Update index alias API">index aliases</a>
that point to a missing or closed index.</p>
<p>Defaults to <code class="literal">true</code>.</p>
</dd>
<dt>
<span class="term">
<code class="literal">expand_wildcards</code>
</span>
</dt>
<dd>
<p>(Optional, string) Controls what kind of indices that wildcard expressions can
expand to. Multiple values are accepted when separated by a comma, as in
<code class="literal">open,hidden</code>. Valid values are:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">all</code>
</span>
</dt>
<dd>
Expand to open and closed indices, including <a class="xref" href="index-modules.html#index-hidden">hidden indices</a>.
</dd>
<dt>
<span class="term">
<code class="literal">open</code>
</span>
</dt>
<dd>
Expand only to open indices.
</dd>
<dt>
<span class="term">
<code class="literal">closed</code>
</span>
</dt>
<dd>
Expand only to closed indices.
</dd>
<dt>
<span class="term">
<code class="literal">hidden</code>
</span>
</dt>
<dd>
Expansion of wildcards will include <a class="xref" href="index-modules.html#index-hidden">hidden indices</a>.
Must be combined with <code class="literal">open</code>, <code class="literal">closed</code>, or both.
</dd>
<dt>
<span class="term">
<code class="literal">none</code>
</span>
</dt>
<dd>
Wildcard expressions are not accepted.
</dd>
</dl>
</div>
<p>Defaults to <code class="literal">open</code>.</p>
</dd>
<dt>
<span class="term">
<code class="literal">ignore_unavailable</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, missing or closed indices are not included in the
response. Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
<h3>
<a id="indices-reload-analyzers-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/indices/apis/reload-analyzers.asciidoc">edit</a>
</h3>
<p>Use the <a class="xref" href="indices-create-index.html" title="Create index API">create index API</a>
to create an index with a search analyzer
that contains an updateable synonym filter.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Using the following analyzer as an index analyzer results in an error.</p>
</div>
</div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT /my_index
{
    "settings": {
        "index" : {
            "analysis" : {
                "analyzer" : {
                    "my_synonyms" : {
                        "tokenizer" : "whitespace",
                        "filter" : ["synonym"]
                    }
                },
                "filter" : {
                    "synonym" : {
                        "type" : "synonym_graph",
                        "synonyms_path" : "analysis/synonym.txt", <a id="CO601-1"></a><i class="conum" data-value="1"></i>
                        "updateable" : true <a id="CO601-2"></a><i class="conum" data-value="2"></i>
                    }
                }
            }
        }
    },
    "mappings": {
        "properties": {
            "text": {
                "type": "text",
                "analyzer" : "standard",
                "search_analyzer": "my_synonyms" <a id="CO601-3"></a><i class="conum" data-value="3"></i>
            }
        }
    }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1866.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO601-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Includes a synonym file.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO601-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Marks the token filter as updateable.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO601-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Marks the analyzer as a search analyzer.</p>
</td>
</tr>
</table>
</div>
<p>After updating the synonym file,
use the <a class="xref" href="indices-reload-analyzers.html" title="Reload search analyzers API">analyzer reload API</a>
to reload the search analyzer
and pick up the file changes.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST /my_index/_reload_search_analyzers</pre>
</div>
<div class="console_widget" data-snippet="snippets/1867.console"></div>
<p>The API returns the following response.</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
    "_shards" : {
        "total" : 2,
        "successful" : 2,
        "failed" : 0
    },
    "reload_details" : [
        {
            "index" : "my_index",
            "reloaded_analyzers" : [
                "my_synonyms"
            ],
            "reloaded_node_ids" : [
                "mfdqTXn_T7SGr2Ho2KT8uw"
            ]
        }
    ]
}</pre>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="migration-api-deprecation.html">« Deprecation info APIs</a>
</span>
<span class="next">
<a href="rollup-apis.html">Rollup APIs »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>